Skip to content

Conversation

@yeshamavani
Copy link
Collaborator

@yeshamavani yeshamavani commented Nov 6, 2025

Description

Updated the tenant management service README file

Fixes #109

GH-109

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Intermediate change (work in progress)

Checklist:

  • Performed a self-review of my own code
  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Any dependent changes have been merged and published in downstream modules

@vaibhavbhalla2505 vaibhavbhalla2505 marked this pull request as ready for review November 11, 2025 05:02
@vaibhavbhalla2505 vaibhavbhalla2505 force-pushed the GH-109 branch 2 times, most recently from 5c9f940 to a466394 Compare November 11, 2025 07:49

```typecript
this.bind(TenantManagementServiceBindings.Config).to({
useCustomSequence:true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useSymmetric hoga , check again

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!


**Tenants** - main model of the service that represents a tenant in the system, either pooled or siloed

**TenantsConfig** - to save any tenant specific data related to idP
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TenantConfig model is being deleted in this pr, but mentioned here in models section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!


**Invoice** - this model represents an invoice with the amount and period generated for a tenant in the system

**Leads** - this model represents a lead that could eventually be a tenant in the system
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the db schema

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!


When a new tenant is provisioned, the provider automatically:
- Creates a Realm in Keycloak for that tenant.
(Each tenant gets its own isolated authentication space.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add auth0 details as well

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

@vaibhavbhalla2505 vaibhavbhalla2505 force-pushed the GH-109 branch 2 times, most recently from 1cf04af to 7de74ef Compare November 12, 2025 06:04
## Direct Tenant Onboarding

In addition to the lead-based onboarding flow, a new tenant can also be onboarded directly without creating a lead first.
This capability is designed specifically for control plane administrators, who can create and provision tenants directly through the management APIs.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention the endpoint here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

## Event Publishing
This service now supports pluggable event strategies — EventBridge, SQS, and BullMQ — through the loopback4-message-bus-connector.

The service supports pluggable event strategies — EventBridge, SQS, and BullMQ — through the loopback4-message-bus-connector.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link the package here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the tenant management Readme

4 participants